[Workspace] Add User level setting #7953

Hailong-am · 2024-09-02T02:51:13Z

Description

This PR includes

user settings page
ui_setting_client changes to support user personal settings
UserUISettingsClientWrapper to translate user id placeholder to real user id

Issues Resolved

#7821

#7909

Screenshot

user_settings.mov

Testing the changes

Run OSD enabled yarn start --no-base-path --workspace.enabled=true
make sure security is enabled
open http://localhost:5601, and then go to dev tools
Run kibana search to make sure global setting been created

GET .kibana/_search
{
  "query": {
    "bool": {
      "must": [
        {
          "match": {
            "type": "config"
          }
        }
      ]
    }
  }

Run command to add user setting, after that run kibana query again to verify
a config doc with id config:admin been indexed and it has defaultWorkspace as "ABC"

curl --request POST \
  --url http://localhost:5601/api/opensearch-dashboards/settings \
  --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
  --header 'Content-Type: application/json' \
  --header 'osd-xsrf: osd-fetch' \
  --data '{
 "changes": {
  "defaultIndex": "logstash-*",
  "defaultWorkspace": "ABC"
 }
}'

Changelog

feat: [Workspace] Support user personal settings

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

github-actions · 2024-09-02T02:51:52Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

codecov · 2024-09-02T03:04:51Z

Codecov Report

Attention: Patch coverage is 67.48971% with 79 lines in your changes missing coverage. Please review.

Project coverage is 60.59%. Comparing base (d22b68b) to head (5e83f3f).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/plugins/workspace/server/utils.ts	5.55%	17 Missing ⚠️
src/core/server/ui_settings/ui_settings_client.ts	77.55%	4 Missing and 7 partials ⚠️
...rkspace/public/components/workspace_list/index.tsx	80.39%	7 Missing and 3 partials ⚠️
src/plugins/advanced_settings/public/plugin.ts	43.75%	8 Missing and 1 partial ⚠️
...d_settings/public/management_app/user_settings.tsx	64.28%	4 Missing and 1 partial ⚠️
src/plugins/workspace/server/routes/index.ts	0.00%	5 Missing ⚠️
...ntent_management/public/components/page_render.tsx	55.55%	2 Missing and 2 partials ⚠️
src/plugins/workspace/public/plugin.ts	50.00%	3 Missing and 1 partial ⚠️
...r/saved_objects/user_ui_settings_client_wrapper.ts	91.89%	1 Missing and 2 partials ⚠️
...ade_saved_config/create_or_upgrade_saved_config.ts	66.66%	1 Missing and 1 partial ⚠️
... and 6 more

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #7953    +/-   ##
========================================
  Coverage   60.58%   60.59%            
========================================
  Files        3732     3738     +6     
  Lines       88431    88636   +205     
  Branches    13702    13763    +61     
========================================
+ Hits        53579    53709   +130     
- Misses      31592    31650    +58     
- Partials     3260     3277    +17

Flag	Coverage Δ
Linux_1	`28.76% <34.91%> (+<0.01%)`	⬆️
Linux_2	`56.27% <70.58%> (+<0.01%)`	⬆️
Linux_3	`37.50% <43.42%> (+0.06%)`	⬆️
Linux_4	`29.61% <8.33%> (-0.04%)`	⬇️
Windows_1	`28.78% <34.91%> (+<0.01%)`	⬆️
Windows_2	`56.22% <70.58%> (+<0.01%)`	⬆️
Windows_3	`37.51% <43.42%> (+0.06%)`	⬆️
Windows_4	`29.61% <8.33%> (-0.04%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Hailong Cui <[email protected]>

opensearch-trigger-bot · 2024-09-06T13:17:48Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-7953-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 569b70d885cec37ac83d133ef6d8ce0f6c03a02f
# Push it to GitHub
git push --set-upstream origin backport/backport-7953-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-7953-to-2.x.

opensearch-trigger-bot · 2024-09-06T13:17:49Z

The backport to 2.17 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.17 2.17
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.17
# Create a new branch
git switch --create backport/backport-7953-to-2.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 569b70d885cec37ac83d133ef6d8ce0f6c03a02f
# Push it to GitHub
git push --set-upstream origin backport/backport-7953-to-2.17
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.17

Then, create a pull request where the base branch is 2.17 and the compare/head branch is backport/backport-7953-to-2.17.

opensearch-trigger-bot · 2024-09-06T14:23:17Z

The backport to 2.17 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.17 2.17
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.17
# Create a new branch
git switch --create backport/backport-7953-to-2.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 569b70d885cec37ac83d133ef6d8ce0f6c03a02f
# Push it to GitHub
git push --set-upstream origin backport/backport-7953-to-2.17
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.17

Then, create a pull request where the base branch is 2.17 and the compare/head branch is backport/backport-7953-to-2.17.

opensearch-trigger-bot · 2024-09-06T14:23:18Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-7953-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 569b70d885cec37ac83d133ef6d8ce0f6c03a02f
# Push it to GitHub
git push --set-upstream origin backport/backport-7953-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-7953-to-2.x.

Hailong-am · 2024-09-06T14:38:32Z

i will do manual backport due to

 const enableUserControl = core.uiSettings.get('theme:enableUserControl');
    if (enableUserControl) {
      setupTopNavThemeButton(core, core.uiSettings.get('home:useNewHomePage'));
    }

not available in 2.x

(cherry picked from commit 569b70d)

(cherry picked from commit 569b70d) Signed-off-by: Hailong Cui <[email protected]>

(cherry picked from commit 569b70d)

(cherry picked from commit 569b70d) Signed-off-by: Hailong Cui <[email protected]>

* [Workspace] Add User level setting (#7953) (cherry picked from commit 569b70d) Signed-off-by: Hailong Cui <[email protected]> * add experimental to user personal settings and support i18n Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]>

* [Workspace] Add User level setting (#7953) (cherry picked from commit 569b70d) Signed-off-by: Hailong Cui <[email protected]> * add experimental to user personal settings and support i18n Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> (cherry picked from commit eccf54f) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* [Workspace] Add User level setting (#7953) (cherry picked from commit 569b70d) * add experimental to user personal settings and support i18n --------- (cherry picked from commit eccf54f) Signed-off-by: Hailong Cui <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

AMoo-Miki · 2024-09-13T16:06:23Z

Manually backported to 2.x with #8057

github-actions bot added the all-star-contributor label Sep 2, 2024

github-actions bot added the failed changeset label Sep 2, 2024

Hailong-am added 3 commits September 3, 2024 00:33

user level setting

0a6312c

Signed-off-by: Hailong Cui <[email protected]>

add unit test

060a5c3

Signed-off-by: Hailong Cui <[email protected]>

add unit test

de214ec

Signed-off-by: Hailong Cui <[email protected]>

Hailong-am force-pushed the use_level_settings branch from 6275d4e to de214ec Compare September 2, 2024 16:33

Changeset file for PR opensearch-project#7953 created/updated

c2dd98e

github-actions bot removed the failed changeset label Sep 2, 2024

Hailong-am added 8 commits September 3, 2024 00:51

replace with constant DEFAULT_WORKSPACE

80fc1dc

Signed-off-by: Hailong Cui <[email protected]>

Merge branch 'main' into use_level_settings

fd3f6de

update test snapshot

b3e2acf

Signed-off-by: Hailong Cui <[email protected]>

update incorrect type in test data

32becd6

Signed-off-by: Hailong Cui <[email protected]>

Merge branch 'main' into use_level_settings

af15055

Signed-off-by: Hailong Cui <[email protected]>

fix lint

cabf38a

Signed-off-by: Hailong Cui <[email protected]>

replace user placeholder when security not enabled

6776cdc

Signed-off-by: Hailong Cui <[email protected]>

remove version for user level settings

9dee281

Signed-off-by: Hailong Cui <[email protected]>

Hailong-am force-pushed the use_level_settings branch from b45550a to 9dee281 Compare September 3, 2024 15:29

Hailong-am added 2 commits September 4, 2024 00:08

clean up

a5156dc

Signed-off-by: Hailong Cui <[email protected]>

Merge remote-tracking branch 'upstream/main' into use_level_settings

6689ff4

Hailong-am marked this pull request as ready for review September 3, 2024 16:10

Hailong-am requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon and zhongnansu as code owners September 3, 2024 16:10

SuZhou-Joe approved these changes Sep 6, 2024

View reviewed changes

ruanyl approved these changes Sep 6, 2024

View reviewed changes

ruanyl merged commit 569b70d into opensearch-project:main Sep 6, 2024
66 of 67 checks passed

opensearch-trigger-bot bot added the failed backport label Sep 6, 2024

SuZhou-Joe added backport 2.x backport 2.17 and removed backport 2.x failed backport backport 2.17 labels Sep 6, 2024

opensearch-trigger-bot bot added the failed backport label Sep 6, 2024

Hailong-am added a commit to Hailong-am/OpenSearch-Dashboards that referenced this pull request Sep 6, 2024

[Workspace] Add User level setting (opensearch-project#7953)

78034d1

(cherry picked from commit 569b70d)

Hailong-am mentioned this pull request Sep 6, 2024

[Manual Backport 2.x] [Workspace] Add user settings #8057

Merged

Hailong-am added a commit to Hailong-am/OpenSearch-Dashboards that referenced this pull request Sep 6, 2024

[Workspace] Add User level setting (opensearch-project#7953)

95f4594

(cherry picked from commit 569b70d) Signed-off-by: Hailong Cui <[email protected]>

Hailong-am added a commit to Hailong-am/OpenSearch-Dashboards that referenced this pull request Sep 6, 2024

[Workspace] Add User level setting (opensearch-project#7953)

a328c3c

(cherry picked from commit 569b70d)

Hailong-am added a commit to Hailong-am/OpenSearch-Dashboards that referenced this pull request Sep 6, 2024

[Workspace] Add User level setting (opensearch-project#7953)

f7ed69d

(cherry picked from commit 569b70d) Signed-off-by: Hailong Cui <[email protected]>

Hailong-am mentioned this pull request Sep 6, 2024

[Manual backport 2.17][Workspace] Add User level setting (#7953) #8058

Closed

SuZhou-Joe pushed a commit to SuZhou-Joe/OpenSearch-Dashboards that referenced this pull request Sep 8, 2024

[Workspace] Add User level setting (opensearch-project#7953)

365ac96

SuZhou-Joe pushed a commit to SuZhou-Joe/OpenSearch-Dashboards that referenced this pull request Sep 10, 2024

[Workspace] Add User level setting (opensearch-project#7953)

2b41341

AMoo-Miki removed the failed backport label Sep 13, 2024

This was referenced Nov 15, 2024

Compatibility with OpenSearch 2.18.0 wazuh/wazuh-dashboard#415

Closed

Compatibility with OpenSearch 2.18.0 wazuh/wazuh-dashboard-plugins#7162

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] Add User level setting #7953

[Workspace] Add User level setting #7953

Hailong-am commented Sep 2, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024

codecov bot commented Sep 2, 2024 •

edited

Loading

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

Hailong-am commented Sep 6, 2024

AMoo-Miki commented Sep 13, 2024

[Workspace] Add User level setting #7953

[Workspace] Add User level setting #7953

Conversation

Hailong-am commented Sep 2, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

github-actions bot commented Sep 2, 2024

❌ Empty Changelog Section

codecov bot commented Sep 2, 2024 • edited Loading

Codecov Report

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

Hailong-am commented Sep 6, 2024

AMoo-Miki commented Sep 13, 2024

Hailong-am commented Sep 2, 2024 •

edited

Loading

codecov bot commented Sep 2, 2024 •

edited

Loading